home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / X11 / xsw / include / help.h < prev    next >
Text File  |  1995-05-09  |  16KB  |  397 lines
  1. /*
  2.  *    @(#) help.h 12.1 95/05/09 SCOINC
  3.  */
  4. /***************************************************************************
  5.  *
  6.  *    Copyright (c) 1990-1993        The Santa Cruz Operation, Inc.
  7.  *
  8.  *    All rights reserved.  No part of this program or publication may be
  9.  *    reproduced, transmitted, transcribed, stored in a retrieval system,
  10.  *    or translated into any language or computer language, in any form or
  11.  *    by any means, electronic, mechanical, magnetic, optical, chemical,
  12.  *    biological, or otherwise, without the prior written permission of:
  13.  *    
  14.  *        The Santa Cruz Operation , Inc.        (408) 425-7222
  15.  *        400 Encinal St., Santa Cruz, California 95060 USA
  16.  *
  17.  **************************************************************************/
  18. /*
  19.  * Modification History
  20.  *
  21.  * S003, 21-Sep-93, rickra
  22.  *    Added info on disk space.....
  23.  *
  24.  * S002, 27-May-93, rickra
  25.  *     Added the PS MEM View stuff.....
  26.  *
  27.  * S001, 01-Jan-93, rickra
  28.  *     Did some minor clean up.
  29.  * S000, 30-Sep-92, rickra
  30.  *     Added copyright and modification history
  31.  */
  32.  
  33. char     *help_string_general[] = {
  34. /*2345678901234567890123456789012345678901234567890-------------------*/
  35. "                      XSW - X System Watch\n",
  36. "\n",
  37. "\n",
  38. "\n",
  39. /*--------------------------------------------------------------------*/
  40. "Xsw is a X system watch program that monitors a system and displays\n",
  41. "information in a meaningful manner. There are several viewing options\n",
  42. "listed below with a brief description of their displays. \n",
  43. "\n",
  44. "\n",
  45. "Main Display - The main display contains the following, from left to \n",
  46. "right:\n",
  47. "\n",
  48. "    The chosen interval.\n",
  49. "    The actual interval.\n",
  50. "    The number of users currently on the system.\n",
  51. "\n",
  52. "    To change the interval, you must press '+' to increase the \n",
  53. "    interval or '-' to decrease the sampling interval. Please note\n",
  54. "    that if xsw cannot keep    up with the choosen interval rate, xsw\n",
  55. "    will 'fall behind' and it will appear that xsw is not responding\n",
  56. "    to your commands. Thus, it is important    to be sure that the \n",
  57. "    actual interval is not much greater than the choosen interval.\n",
  58. "    Any color, if you have color available, other than green, means\n",
  59. "    that xsw is having problems maintaining the choosen interaval.\n",
  60. "    The choosen interval is always constant.\n",
  61. "\n",
  62. "\n",
  63. "CPU -     Displays CPU usage broken down into user, kernel, and break. The\n",
  64. "    numbers presented represent a percent of the total. Averages are\n",
  65. "    given by the current interval sample, I, I*5, and I*10. As the\n",
  66. "    interval changes, so does each subsequent interval calculations.\n",
  67. "\n",
  68. "\n",
  69. "Wait -    Displays CPU Wait broken down into I/O, page I/O and swap. The\n",
  70. "    numbers presented represent a percent or the total. Averages are\n",
  71. "    given by the current interval sample, I, I*5 and I*10. As the\n",
  72. "    interval changes, so does each subsequent interval calculations.\n",
  73. "\n",
  74. "\n",
  75. "Cache - Display disk cache hit percentage. The number presented is the\n",
  76. "    percent hit for either read or write. An average is also\n",
  77. "    presented which is calculated over time from the initial display.\n",
  78. "\n",
  79. "\n",
  80. "Other - Displays NFILES, NINODES, NPROC, NREGION, and CBLOCKS usage. The\n",
  81. "    numbers presented are: currently configured into the kernel, the\n",
  82. "    maximum that was allocated, and the current allocation.\n",
  83. "\n",
  84. "\n",
  85. "MEM   - Displays memory usage.  % Memory in use, % Swap in use,\n",
  86. "    and  % \"virtual\" physical memory.\n",
  87. "\n",
  88. "\n",
  89. "PS CPU - Displays CPU usage by process. The display consist of:\n",
  90. "\n",
  91. "    S    - The state of the process..\n",
  92. "        s - The process is sleeping\n",
  93. "        R - The process is running\n",
  94. "        p - The process is on the run queue\n",
  95. "        S - The process is in core.\n",
  96. "    USER - The user of the process.\n",
  97. "    PID  - The Process ID.\n",
  98. "    CPU  - Processor utilization for scheduling.\n",
  99. "    PRI  - The priority of the process.\n",
  100. "    NI   - The nice value, used in priority computation.\n",
  101. "    UCPU - The User process time.\n",
  102. "    SCPU - The System process time.\n",
  103. "    SIZE - The size of the swappable process's image in main memory.\n",
  104. "    TTY  - The controlling terminal for the process(the message '??'\n",
  105. "           is printed when there is no controlling terminal).\n",
  106. "    CMD  - The command name.\n",
  107. "\n",
  108. "\n",
  109. "PS IO - Displays Disk I/O on a per process basis. The display consis\n",
  110. "    of:\n",
  111. "\n",
  112. "    USER  - The user of the process.\n",
  113. "    PID   - The Process ID.\n",
  114. "    SWAP  - The number of blocks transfered to or from a swap device.\n",
  115. "    CHAR  - The number of bytes read or written.\n",
  116. "    READ  - The number of blocks read.\n",
  117. "    WRITE - The number of blocks written.\n",
  118. "    TOTAL - The  sum of READ and WRITE.\n",
  119. "\n",
  120. "\n",
  121. "PS MEM - Displays memory in several different ways, depending upon the .\n",
  122. "    \"VIEW\" choosen:\n",
  123. "\n",
  124. "    \"S & P\": In core memory broken down by shared and private.\n",
  125. "\n",
  126. "    USER  - The user of the process.\n",
  127. "    PID   - The Process ID.\n",
  128. "    VSIZE - The virtual size of the process. This is the maximum\n",
  129. "        size of the process.\n",
  130. "    SHRD  - This is the shared memory size of the process.\n",
  131. "    PRIV  - This is the privated memory size of the process.\n",
  132. "    WTD   - This is the weighted memory size of this process.\n",
  133. "        Basically, this number is the shared memory size divided\n",
  134. "        by the reference count.\n",
  135. "    TOTAL - This is the total in core memory size.\n",
  136. "    CMD   - The command name.\n",
  137. "\n",
  138. "\n",
  139. "    \"CORE DBD\": DBD that is in core memory only.\n",
  140. "\n",
  141. "    USER  - The user of the process.\n",
  142. "    PID   - The Process ID.\n",
  143. "    VSIZE - The virtual size of the process. This is the maximum\n",
  144. "        size of the process.\n",
  145. "    NONE  - Memory that the process has allocated.\n",
  146. "    SWAP  - Swap memory that is in core.\n", 
  147. "    FILE  - File memory that is in core.\n",
  148. "    LSTFILE - Last file memory that is in core.\n",
  149. "    TOTAL - Total memory in core.\n",
  150. "    CMD   - The command name.\n",
  151. "\n",
  152. "\n",
  153. "    \"ALL DBD\": All memory types, regaurdless of their location.\n",
  154. "\n",
  155. "    USER  - The user of the process.\n",
  156. "    PID   - The Process ID.\n",
  157. "    VSIZE - The virtual size of the process. This is the maximum\n",
  158. "        size of the process.\n",
  159. "    NONE  - Memory that the process has allocated.\n",
  160. "    SWAP  - Memory that is in core as well as swap.\n", 
  161. "    FILE  - Memory that is in core as well as in file.\n",
  162. "    LSTFILE - Memory that is in core as well as in last file.\n",
  163. "    ZERO  - Memory that the process has allocated, but not touched yet.\n",
  164. "    FILL  - Memory that the process ???.\n",
  165. "    IOMAP - Memory that s I/O mapped.\n",
  166. "    WINDOW - Special memory type.\n",
  167. "    CMD   - The command name.\n",
  168. "\n",
  169. "\n",
  170. "    \"NONE CORE DBD\": DBD that is NOT in core.\n",
  171. "\n",
  172. "    USER  - The user of the process.\n",
  173. "    PID   - The Process ID.\n",
  174. "    VSIZE - The virtual size of the process. This is the maximum\n",
  175. "        size of the process.\n",
  176. "    SWAP  - Memory that is on swap only.\n", 
  177. "    FILE  - Memory that is on file only.\n",
  178. "    LSTFILE - Memory that is on last file only.\n",
  179. "    ZERO  - Memory that the process has allocated, but not touched yet.\n",
  180. "    FILL  - Memory that the process ???.\n",
  181. "    IOMAP - Memory that s I/O mapped.\n",
  182. "    WINDOW - Special memory type.\n",
  183. "    CMD   - The command name.\n",
  184. "\n",
  185. "\n",
  186. "Streams - Displays streams statistics. The number presented are: \n",
  187. "\n",
  188. "    Config - What is currently configured into the system.\n",
  189. "    Use    - The current item usage count.\n",
  190. "    %Use   - The percent of Config in use.\n",
  191. "    Total  - The total item usage count.\n",
  192. "    Max    - The maximum item usage count.\n",
  193. "    Fail   - The count of allocations failures.\n",
  194. "\n",
  195. "    across these structures:\n",
  196. "\n",
  197. "    NSTREAM  - Stream allocation data.\n",
  198. "    NQUEUE   - Queue allocation data.\n",
  199. "    MBLOCK   - Message block allocation data.\n",
  200. "    DBLK TOT - Aggredate data block allocation data.\n",
  201. "    DBLK4    - 4 byte stream buffer.\n",
  202. "    DBLK16   - 16 byte stream buffer.\n",
  203. "    DBLK64   - 64 byte stream buffer.\n",
  204. "    DBLK128  - 128 byte stream buffers.\n",
  205. "    DBLK256  - 256 byte stream buffers.\n",
  206. "    DBLK512  - 512 byte stream buffers.\n",
  207. "    DBLK1024 - 1024 byte stream buffers.\n",
  208. "    DBLK2048 - 2048 byte stream buffers.\n",
  209. "    DBLK4096 - 4096 byte stream buffers.\n",
  210. "\n",
  211. "\n",
  212. "NFS stat - Displays statistics on both the client and server side of\n",
  213. "    NFS.\n",
  214. "\n",
  215. "    NFS client:\n",
  216. "\n",
  217. "    calls    - The total number of calls.\n",
  218. "    badcalls - The number of rejected NFS calls.\n",
  219. "    nclget   - The number of times the client had to request a new\n",
  220. "           handle for an NFS call.\n",
  221. "    nclsleep - The number of times a NFS call was blocked becasue no\n",
  222. "           client was currently availble. Please see man page on\n",
  223. "           nfsclnt if this number is greater than 0.\n",
  224. "\n",
  225. "    null - fsstat - Breakdown of NFS calls by procedure.\n",
  226. "\n",
  227. "    NFS server:\n",
  228. "\n",
  229. "    calls    - The total number of calls.\n",
  230. "    badcalls - The number of rejected NFS calls.\n",
  231. "\n",
  232. "    null - fsstat - Breakdown of NFS calls by procedure.\n",
  233. "\n",
  234. "    RPC client:\n",
  235. "    calls    - The total number of calls made to all NFS servers.\n",
  236. "    badcalls - The number of RPC calls that returned an error.\n",
  237. "    retrans  - The number of calls that were retransmitted because\n",
  238. "           not reponse was recieved from the NFS server within\n",
  239. "           the timeout period.\n",
  240. "    badxid   - Indicates that the server is recieving some\n",
  241. "           retransmitted requests, but is taking a long time to\n",
  242. "           reply to all NFS requests.\n",
  243. "    timeout  - Number of calls that timed out waiting for a server\n",
  244. "           response.\n",
  245. "    wait     - The number of calls that had to wait on a busy client\n",
  246. "           handle to be refreshed.\n",
  247. "    peekerrs - The number of 'peek' into call message that failed.\n",
  248. "    badresps - The number of minimal reply message size failures.\n",
  249. "\n",
  250. "    RPC server:\n",
  251. "    calls    - The total number of NFS RPC calls made to this server,\n",
  252. "            from all clients.\n",
  253. "    badcalls - The number of RPC calls that were rejected, before the\n",
  254. "           request was passed to the NFS service routines.\n",
  255. "    nullrecv - The number of times an nfsd daemon is scheduled to run\n",
  256. "             but finds that there is no packet on the NFS service\n",
  257. "           socket queue.\n",
  258. "    badlen   - The RPC request recieved by the server was too short.\n",
  259. "    xdrcall  - The XDR headers in the packet are malformed.\n",
  260. "\n",
  261. "\n",
  262. "Sysinfo - Displays the sysinfo and minfo data structures. These data\n",
  263. "       structures contain a wide range of kernel statistics.\n",
  264. "\n",
  265. "\n",
  266. "VBT     - Displays the var, bootinfo and tune data structures. These\n",
  267. "       data structures contain a wide range of kernel static\n",
  268. "       values.\n",
  269. "\n",
  270. "\n",
  271. "Device Stats. - Displays activity for each block device. Items displayed\n",
  272. "are:\n",
  273. "\n",
  274. " %busy, avque -- portion of time the device was busy servicing a transfer\n",
  275. "           request, average number of requests outstanding during \n",
  276. "          that time.\n",
  277. "\n",
  278. " r+w/s, blks/s -- number of data transfers from or to device, number\n",
  279. "           of bytes transferred in 512-byte units.\n",
  280. "\n",
  281. " avwait, avserv -- average time, in milliseconds, that transfer requests\n",
  282. "            wait idly on queue, and average time to be serviced\n",
  283. "            (which for disks includes seek, rotational latency, and\n",
  284. "            data transfer times).\n",
  285. "\n",
  286. "\n",
  287. "Disk Space - Displays disk space free and used for on-line filesystems by\n",
  288. "          examining the counts kept in the super-blocks.\n",
  289. "          Those filesystem which are not accessable will be denoted by\n",
  290. "          a question mark at the begining of the filesystem totals.\n",
  291. "\n",
  292. "ALLDONE"};
  293.  
  294. char     *help_string_options[] = {
  295. "                   XSW Options\n",
  296. "\n",
  297. "\n",
  298. "\n",
  299. "Xsw provides for many options at start up time, as will as some run\n",
  300. "time options. The follwing is a list of start up options, each with\n",
  301. "a brief explantion.\n",
  302. "\n",
  303. "-help                print out this message\n",
  304. "-geometry            size (in characters) and position\n",
  305. "-title                title for the xsw window\n",
  306. "-server \n",
  307. "   host[:window,window,..]    specifies a server to connect to and \n",
  308. "                resource window to pop up. Resource window\n",
  309. "                can be one of: cpu,wait,cache,other,pscpu,\n",
  310. "                psio,psmem,streams,nfs,sysinfo,vbt,disk,mem,\n",
  311. "                diskspace\n",
  312. "-bg color            background color\n",
  313. "-fg color            foreground color\n",
  314. "-fn fontname            text font\n",
  315. "-labelc color            text label color\n",
  316. "-titleb color            text foreground color for window title bars\n",
  317. "-uc color            User CPU percentage scale color\n",
  318. "-kc color            Kernel CPU percentage scale color\n",
  319. "-bc color            Break CPU percentage scale color\n",
  320. "-ic color            I/O wait percentage scale color\n",
  321. "-pc color            Page I/O wait percentage scale color\n",
  322. "-sc color            Swap I/O wait percentage scale color\n",
  323. "-rca percent            Read Cache Hit alarm percentage\n",
  324. "-wca percent            Write Cache Hit alarm percentage\n",
  325. "-rcw percent            Read Cache Hit warning percentage\n",
  326. "-wcw percent            Write Cache Hit warning percentage\n",
  327. "-nfilec color            NFILE percentage scale color\n",
  328. "-ninodec color            NINODE percentage scale color\n",
  329. "-nprocc color            NPROC percentage scale color\n",
  330. "-nregionc color            NREGION percentage scale color\n",
  331. "-nfileac color            NFILE Alarm percentage scale color\n",
  332. "-ninodeac color            NINODE Alarm percentage scale color\n",
  333. "-nprocac color            NPROC Alarm percentage scale color\n",
  334. "-nregionac color        NREGION Alarm percentage scale color\n",
  335. "-nfileat percent        NFILE Alarm percent Threshhold\n",
  336. "-ninodeat percent        NINODE Alarm percent Threshhold\n",
  337. "-nprocat percent        NPROC Alarm percent Threshhold\n",
  338. "-nregionat percent        NREGION Alarm percent Threshhold\n",
  339. "-nfilewc color            NFILE Warning percentage scale color\n",
  340. "-ninodewc color            NINODE Warning percentage scale color\n",
  341. "-nprocwc color            NPROC Warning percentage scale color\n",
  342. "-nregionwc color        NREGION Warning percentage scale color\n",
  343. "-nfilewt percent        NFILE Warning percent Threshhold\n",
  344. "-ninodewt percent        NINODE Warning percent Threshhold\n",
  345. "-nprocwt percent        NPROC Warning percent Threshhold\n",
  346. "-nregionwt percent        NREGION Warning percent Threshhold\n",
  347. "-psmemc color            Memory color\n",
  348. "-psmemgrowc color        PS Memory growing color\n",
  349. "-psmemshrinkc color        PS Memory shrinking color\n",
  350. "-psmemnewc color        PS Memory new color\n",
  351. "-pscpuidlec color        PS CPU idle color\n",
  352. "-pscpuactivec color        PS CPU active color\n",
  353. "-pscpunewc color        PS CPU new color\n",
  354. "-pscpurunc color        PS CPU running color\n",
  355. "-psioidlec color        PS IO idle color\n",
  356. "-psioactivec color        PS IO active color\n",
  357. "-psionewc color            PS IO new color\n",
  358. "-memusedc color            Memory Used color\n",
  359. "-memusedwc color        Memory Used Warning color\n",
  360. "-memusedac color        Memory Used Alarm color\n",
  361. "-muwt percent             Memory Used Warning Threshhold\n",
  362. "-muat percent             Memory Used Alarm Threshhold\n",
  363. "-swapusedc color        Swap Memory Used color\n",
  364. "-swapusedwc color        Swap Memory Used Warning color\n",
  365. "-swapusedac color        Swap Memory Used Alarm color\n",
  366. "-suwt percent             Swap Memory Used Warning Threshhold\n",
  367. "-suat percent             Swap Memory Used Alarm Threshhold\n",
  368. "-disklosingc color        Disk Space Losing color\n",
  369. "-diskgainingc color        Disk Space Gaining color\n",
  370. "-diskstablec color        Disk Space Stable color\n",
  371. "-availswapusedc color        Avail. Swap Memory Used color\n",
  372. "-availswapusedwc color        Avail. Swap Memory Used Warning color\n",
  373. "-availswapusedac color        Avail. Swap Memory Used Alarm color\n",
  374. "-asuwt percent             Avail. Swap Memory Used Warning Threshhold\n",
  375. "-asuat percent             Avail. Swap Memory Used Alarm Threshhold\n",
  376. "-auxbtnonbgc color        Auxillary Buttons \"ON\" Background\n",
  377. "-auxbtnonffgc color        Auxillary Buttons \"ON\" Foreground\n",
  378. "-auxbtnoffbgc color        Auxillary Buttons \"OFF\" Background\n",
  379. "-auxbtnofffgc color        Auxillary Buttons \"OFF\" Foreground\n",
  380. "-numericc color            Numeric color\n",
  381. "-numericwc color        Numeric Warning color\n",
  382. "-numericac color        Numeric Alarm color\n",
  383. "-snumericc color        Static Numeric color\n",
  384. "\n",
  385. "\n",
  386. "\ALLDONE"};
  387.  
  388. char     *help_string_problems[] = {
  389. "                   XSW Known Problems \n",
  390. "\n",
  391. "\n",
  392. "\n",
  393. "    1) NQUEUE data structure is not accurate in the kernel......\n",
  394. "\n",
  395. "\n",
  396. "ALLDONE"};
  397.